-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganize Developing.md sections (fix for #3263) #3264
Conversation
Merged Requirements and Setup Environment sections. Moved new section above Checkout Your Fork because they are prerequisites to it.
|
Hi @AlexReiff. Thanks for your PR. I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/ok-to-test |
/kind documentation |
|
||
1. [`git`](https://help.github.com/articles/set-up-git/): For source control | ||
|
||
1. [`go`](https://golang.org/doc/install): The language Tekton Pipelines is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you specify which version of golang is needed to be installed? If you install an old version. I believe that KO throws a very unhelpful error.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, I think your need to edit your pr to include /kind documentation
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just a side note that @AlexReiff was moving the existing docs around - adding the version is a good idea but i think it is np if he doesn't want to be the one to add it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I debated this. I decided against this because it's more an issue with installing Ko than installing Tekton.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one nit about removing a link to the section that was deleted
thanks for this @AlexReiff !
DEVELOPMENT.md
Outdated
1. [Create and checkout a repo fork](#checkout-your-fork) | ||
1. Set up your [shell environment](#environment-setup) | ||
1. Install [requirements](#requirements) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think you deleted this section so maybe we should remove this also?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh good catch, updated.
hm looks like this is stuck again, opened tektoncd/plumbing#581 |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bobcatfish The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Thanks for this! 😸 |
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/lgtm |
Merged Requirements and Setup Environment sections. Moved new section above Checkout Your Fork because they are prerequisites to it.
Changes
Reorganized sections of Developing.md to fix the two issues in #3263 so all information needed to setup the development environment and required installations is in one section in the doc. Moved it before the Checkout your Fork section, because that section relies on GOPATH already being configured.
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmd
dir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.
Release Notes